Miscellaneous Commands / Functions

Miscellaneous Commands / Functions

Previous Top Next

Miscellaneous but useful Clip commands and functions.

Commands:

^!Delay nnn
Adds a delay in 10th seconds before next instruction is executed. nnn is the time value.

^!DirectPrint "Title" Data (added in v4.8)
Prints text directly to the printer, bypassing NoteTab's print procedure. Uses default printer settings. Title is the text shown in the Print manager and Data is the text to send directly to the printer. Data can contain printer control codes.

^!FileScramble "InputName"[ "OutputName"[ "Key"]] (added in v4.84)
encrypts and decrypts files. This command can automatically detect if the file needs encrypting or decrypting. InputName is the file to encrypt or decrypt. Use the optional OutputName to define the name of the file created by the operation. If the file is going to be encrypted and you don't specify an output name, the name will be based on InputName with the extension ".npw". If the file is going to be decrypted and you don't specify an output name, the original file name will be used. Use the optional "Key" parameter to define an encryption password (max. 255 characters). Make sure you don't forget your password, or you will not be able to restore your encrypted data.
The encryption algorithm is based on RC4 ("RC4" is a trademark of RSA Data Security, Inc.). You should not rely on this feature to protect very sensitive data.

^!Goto Label
Continues Clip execution from the specified label defined in the Clip.

^!Help (added in v4.6)
or
^!Help "FileName" (added in v4.6)
or
^!Help "[FileName]" Keyword (added in v4.6)
Displays the indicated Help file or the NoteTab Help file if no parameter is specified. Displays the topic in the keyword table that matches the specified keyword, if there is an exact match. If there is more than one match, displays the Index tab. The following example will display the topics discussing Perl in the NoteTab Help file: ^!Help "" Perl

^!ProgIniLoad [IniName] (added in v4.6)
Loads options from the NoteTab ini file or registry. Optionally, you can specify an alternative INI file (it must exist or else the command sets the error condition). Note that the [AutoLoad] section is ignored by this command.

^!ProgIniSave [IniName] (added in v4.6)
Saves the current program settings into the NoteTab ini file or registry. Optionally, you can specify an alternative INI file (it is automatically created if it does not exist).

^!ReloadLibrary (added in v4.52)
Reloads the current Clipbook library. Useful if another application has modified it.

^!SetErrorLabel LabelName (added in v4.52)
Defines a label to which execution should jump whenever the error flag is set. The scope of this command is limited to the Clip where it was invoked. Note that when an error label is defined, the ^!IfError command is ignored.

^!SetPasteboardDivider DividerText
Use this command to change the Paste Board divider. Accepts tokens to specify new lines (^p) and tabs (^t).

^!SetScreenUpdate [On|Off] (added in v4.52)
Enables or disables updating of the NoteTab application window. Disabling updating when a repetitive sequence of Clip commands affects the text layout can significantly improve the processing speed. The scope of this command is limited to the Clip (and eventual sub-Clips) where it was invoked. When a Clip ends, screen updating is automatically re-enabled. Since version 4.6, the following commands will now force a screen refresh while screen updating is disabled: ^!Prompt, ^!Continue, ^!Skip, ^!Info, ^!StatusShow, and Clip Wizards based on ^?{...} type fields.

^!ShowClipbook [TRUE|FALSE]
Shows or hides the Clipbook window.

^!Sound FileName (or Windows sound)
Plays Wave file or Windows sound (SystemAsterisk, SystemExclamation, SystemHand, SystemQuestion, SystemDefault).

^!UUDecode "InputName"[ "OutputName"] (added in v4.84)
InputName is the file to decode. Use the optional OutputName to define the name of the UUEncoded data file. If you don't specify an output name, the name stored in the encoded file will be used.

^!UUEncode "InputName"[ "OutputName"] (added in v4.84)
InputName is the file to encode. Use the optional OutputName to define the name of the UUEncoded data file. If you don't specify an output name, the name will be based on InputName with the extension ".uue".

Functions:

^$GetAppFileName$ (added in v4.8)
Returns the file and path name of the NoteTab program file. Example, with default folder for NoteTab Pro:
^$GetAppFileName$ -> C:\Program Files\NoteTab Pro\NotePro.exe

^$GetAppTitle$ (added in v4.52)
or
^$GetAppTitle(TitleText)$ (added in v4.52)
Returns the full title of the active application window when no title is specified, or the window matching the specified text.

^$GetCrcFile("Filename")$ (added in v4.84)
Returns the CRC32 (cyclic redundancy check) value of the specified file. Example:
^$GetCrcFile("^$GetAppFileName$")$

^$GetCrcText("Text")$ (added in v4.84)
Returns the CRC32 (cyclic redundancy check) value of the specified text. Example:
^$GetCrcText("^$GetText$")$

^$GetEditorType$
Returns NTS if the editor is NoteTab Std or Light, and NTP if it is NoteTab Pro.

^$GetLibraryName$
Returns the name of the library running the Clip.

^$GetMD5File("Filename")$ (added in v4.84)
Returns the MD5 signature of the specified file. The result is produced in hexadecimal format. MD5 is a hashing algorithm that generates a digital signature, or Message Digest, representing the supplied data. The MD5 algorithm was produced by RSA Data Security, Inc. Example:
^$GetMD5File("^$GetAppFileName$")$

^$GetMD5Text("Text")$ (added in v4.84)
Returns the MD5 signature of the specified text. The result is produced in hexadecimal format. MD5 is a hashing algorithm that generates a digital signature, or Message Digest, representing the supplied data. The MD5 algorithm was produced by RSA Data Security, Inc. Example:
^$GetMD5Text("^$GetText$")$

^$GetPasteboardDivider$
Returns the value of the Paste Board divider.

^$GetProgName$ (added in v4.6)
Returns the full name of the NoteTab variant.

^$GetProgVersion$ (added in v4.6)
Returns the current version number.